Fix asymmetric Observation scope propagation in Kotlin Coroutines#36955
Open
arnabnandy7 wants to merge 1 commit into
Open
Fix asymmetric Observation scope propagation in Kotlin Coroutines#36955arnabnandy7 wants to merge 1 commit into
arnabnandy7 wants to merge 1 commit into
Conversation
Introduce a ThreadLocal nesting check inside PropagationContextElement to prevent duplicate/asymmetric thread-local scope updates during nested undispatched coroutine context changes. Closes spring-projects#36929 Signed-off-by: Arnab Nandy <arnab_nandy7@yahoo.com>
384f831 to
40ce895
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR addresses issue #36929 where Kotlin flow-to-flux subscriptions using
PropagationContextElementopen Observation scopes asymmetrically, causingAssertionErrorcrashes inObservationThreadLocalAccessor.restore.Cause of the Issue
During undispatched coroutine context modifications (e.g., from
ChannelFlowKt.withContextUndispatchednested inside the flow's execution path),updateThreadContextis called nestedly on the same thread. When a coroutine suspends within the nested block:finallyblock of the nested block (which callsrestoreThreadContextto close the nested scope) is NOT executed.restoreThreadContext.restoreThreadContextattempts to close the outer scope but finds a dirty thread-local observation stack (with the nested scope still on top), causing Micrometer's assertion to trip.Solution
We introduce a static
ThreadLocal<Integer> nestingDepthtracker insidePropagationContextElement:updateThreadContextis called, we incrementnestingDepth.Scopeimplementation, avoiding nested/asymmetric thread-local scope pushes.WrapperScopethat delegates to the original snapshot scope and resets thenestingDepthto 0 when closed.Verification
Added a unit test
nestedInvocationsinPropagationContextElementTestswhich simulates nested context updates and outer/nested restorations, verifying that no assertion errors are thrown and the Observation stack remains balanced. All tests inspring-corecompiled and passed.